[BETA] Campaign Performance Forecasts

Get campaign performance forecasts with confidence intervals.

⚠️ Beta Access Required

Contact your sales representative to gain access to this endpoint and start using it.

Currently Supported:

• Listing campaigns (autobidding) only

Returns total campaign forecasts (not daily) for:

• Total impressions with confidence intervals
• Total clicks with confidence intervals
• Total purchases with confidence intervals
• Total sales with confidence intervals
• Total ad spend with confidence intervals

Constraints:

• Date range cannot exceed 31 days.

POST /public/v1/toptimize/forecasting/campaign

[BETA] Campaign Performance Forecasts

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/toptimize/forecasting/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignFormat": "listing",
  "dailyBudget": 123,
  "dateRange": {
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "targetRoas": 123,
  "campaignType": "autobidding",
  "products": [
    {
      "id": "<string>"
    }
  ],
  "triggers": [
    {
      "type": "search",
      "value": "<string>"
    }
  ],
  "targets": [
    "ad_spend"
  ]
}
'

200

{
  "forecasts": {
    "impressions": {
      "forecastValue": 150000,
      "forecastIntervalMin": 142000,
      "forecastIntervalMax": 158000
    },
    "clicks": {
      "forecastValue": 12500,
      "forecastIntervalMin": 11800,
      "forecastIntervalMax": 13200
    },
    "purchases": {
      "forecastValue": 875,
      "forecastIntervalMin": 820,
      "forecastIntervalMax": 930
    },
    "sales": {
      "forecastValue": 52500,
      "forecastIntervalMin": 49000,
      "forecastIntervalMax": 56000
    },
    "adSpend": {
      "forecastValue": 10500,
      "forecastIntervalMin": 10000,
      "forecastIntervalMax": 11000
    }
  }
}

Autorizações

Authorization · string · header · obrigatório

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Corpo

application/json

Public API request for a listing campaign performance forecast.

campaignFormat · enum<string> · obrigatório

Campaign format type. Currently only 'listing' is supported.

Opções disponíveis: listing

dailyBudget · number · obrigatório

Daily budget for the campaign

dateRange · PublicDateRange · object · obrigatório

Campaign date range

Show child attributes

targetRoas · number · obrigatório

Target Return on Ad Spend

campaignType · enum<string> · obrigatório

Campaign type (required)

Opções disponíveis: autobidding

products · PublicProductRequest · object[] · obrigatório

List of products in the campaign (required)

Minimum array length: 1

Show child attributes

triggers · PublicTriggerRequest · object[]

List of campaign triggers (optional, defaults to empty list)

Show child attributes

targets · enum<string>[] | null

Optional list of target variables to forecast. If not provided, all targets will be forecasted.

Opções disponíveis: ad_spend, clicks, impressions, purchases, sales

Resposta

200

application/json

Successful Response

forecasts · PublicCampaignForecastMetrics · object · obrigatório

Campaign performance forecasts

Show child attributes